Inscoper::ParamConfig¶

ParamConfig class provides required information for parameter configuration. More...

#include <ParamConfig.h>

Public Functions¶

	Name
	ParamConfig() Default constructor.
void	fromXML(Inscoper::XMLNode & paramNode) Provide parameter information from the XML node.
void	toXML(Inscoper::XMLNode & xmlParent) Export parameter information in an XML node attached to the parent XML node.
unsigned short	getTag() const Get tag of the current parameter.
void	setTag(unsigned short tag) Set tag of the current parameter.
bool	isFixed() const Return whether the parameter is fixed or not.
void	setFixed(bool fixed) Set the parameter as fixed or not.
const std::string &	getDefaultValue() const Get the default value of the parameter.
void	setDefaultValue(const std::string & defaultValue) Set the default value of the parameter.
const std::string &	getMin() const Get the minimum value of the parameter.
void	setMin(const std::string & min) Set the minimum value of the parameter.
const std::string &	getMax() const Get the maximum value of the parameter.
void	setMax(const std::string & max) Set the maximum value of the parameter.
const std::string &	getStep() const Get the step size of the parameter.
void	setStep(const std::string & step) Set the step size of the parameter.

Detailed Description¶

class Inscoper::ParamConfig;

ParamConfig class provides required information for parameter configuration.

This class handles the configuration details for device parameters, including default values, ranges (min/max), step sizes, and whether the parameter is fixed.

Public Functions Documentation¶

function ParamConfig¶

ParamConfig()

Default constructor.

Initializes a new instance of the ParamConfig class.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & paramNode
)

Provide parameter information from the XML node.

Parameters:

paramNode : The XML node containing parameter information

Exceptions:

InscoperException If an error occurred

Populates the parameter configuration from the provided XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Export parameter information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurred

Serializes the parameter configuration to the specified parent XML node.

function getTag¶

unsigned short getTag() const

Get tag of the current parameter.

Return: The current parameter tag

Retrieves the tag associated with this parameter.

function setTag¶

void setTag(
    unsigned short tag
)

Set tag of the current parameter.

Parameters:

tag : The current parameter tag

Assigns a tag to this parameter.

function isFixed¶

bool isFixed() const

Return whether the parameter is fixed or not.

Return: True if the parameter value is fixed, false otherwise

Checks if the parameter value is fixed (unmodifiable).

function setFixed¶

void setFixed(
    bool fixed
)

Set the parameter as fixed or not.

Parameters:

fixed : True if the parameter is fixed

Specifies whether the parameter value should be fixed (unmodifiable).

function getDefaultValue¶

const std::string & getDefaultValue() const

Get the default value of the parameter.

Return: The default value

Retrieves the default value of this parameter.

function setDefaultValue¶

void setDefaultValue(
    const std::string & defaultValue
)

Set the default value of the parameter.

Parameters:

defaultValue : The default value

Sets the default value of this parameter.

function getMin¶

const std::string & getMin() const

Get the minimum value of the parameter.

Return: The minimum value

Retrieves the minimum allowed value of this parameter.

function setMin¶

void setMin(
    const std::string & min
)

Set the minimum value of the parameter.

Parameters:

min : The minimum value

Sets the minimum allowed value of this parameter.

function getMax¶

const std::string & getMax() const

Get the maximum value of the parameter.

Return: The maximum value

Retrieves the maximum allowed value of this parameter.

function setMax¶

void setMax(
    const std::string & max
)

Set the maximum value of the parameter.

Parameters:

max : The maximum value

Sets the maximum allowed value of this parameter.

function getStep¶

const std::string & getStep() const

Get the step size of the parameter.

Return: The step size of the parameter

Retrieves the step size used to increment this parameter.

function setStep¶

void setStep(
    const std::string & step
)

Set the step size of the parameter.

Parameters:

step : The step size of the parameter

Sets the step size used to increment this parameter.

Updated on 2026-04-02 at 10:55:36 +0200